Open API v2 / Emails / System Emails
System Emails
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of system emails by using a "where" filtering
Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Technical name of the system sheet.
DeliveryOptionenum
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages. Possible values: SendAlways, NeverSend, SendOnlyFirstRecurringPayment.Possible values: SendAlwaysNeverSendSendOnlyFirstRecurringPayment
EmailTemplateIdinteger
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages.
FromNamestring · nullable
This is the sending name of the email sent to the recipient.
FromEmailstring · nullable
This is the sending email address of the email sent to the recipient.
Subjectstring · nullable
This is the subject line of the email sent to the recipient.
Bodystring · nullable
This is the body content of the email sent to the recipient.
SystemEventenum
The key parameter that links this letter to the system code. Possible values: PasswordRetrieveEmail, RestoreAdminUserPassword, InviteAdminUser, AdminResetMemberPassword, Invoice, OrderStatusChanged, Quote, GiftVoucher, DropShipping, FirstCartRecoveryEmail, SecondCartRecoveryEmail, LowStockNotification, InvoiceEcom, SupplierNotification, OfflineCreditCardPayment, DoubleOptInEmail, SecureZoneLoginDetails, AffiliateProgramDetails, Forums, ForumsSubscriberAlertforNewPosts, ForumsSubscriberAlertforNewTopics, CustomerServiceTicketing, WorkflowNotification, ThirdrdPartyWorkflowEmails, WorkflowTask, WorkflowCompletion, WorkflowReminder, WorkflowEscalation, WorkflowRejection, ConfirmEmailNotification, OrderStatus, TellAFriend, StorageLimitNotification, FollowUpNotification, AbandonedCartNotification, ItemsLimitNotification, CrmLimitNotification, RecurringReminderNotification.Possible values: PasswordRetrieveEmailRestoreAdminUserPasswordInviteAdminUserAdminResetMemberPasswordInvoiceOrderStatusChangedQuoteGiftVoucherDropShippingFirstCartRecoveryEmailSecondCartRecoveryEmailLowStockNotificationInvoiceEcomSupplierNotificationOfflineCreditCardPaymentDoubleOptInEmailSecureZoneLoginDetailsAffiliateProgramDetailsForumsForumsSubscriberAlertforNewPostsForumsSubscriberAlertforNewTopicsCustomerServiceTicketingWorkflowNotificationThirdrdPartyWorkflowEmailsWorkflowTaskWorkflowCompletionWorkflowReminderWorkflowEscalationWorkflowRejectionConfirmEmailNotificationOrderStatusTellAFriendStorageLimitNotificationFollowUpNotificationAbandonedCartNotificationItemsLimitNotificationCrmLimitNotificationRecurringReminderNotification
DeliveryOptionsarray of objects
List of all available delivery modes for selection in the admin panel.
DisplayNamestring · nullable
A clear name for the administrator.
Valuestring · nullable
The technical value that is recorded in the DeliveryOption field.
curl "https://your-site.webinone.com/api/v2/admin/system-emails" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/system-emails", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/system-emails", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-emails', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-emails"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": 1,
"Name": "Example",
"DeliveryOption": "SendAlways",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"SystemEvent": "PasswordRetrieveEmail",
"DeliveryOptions": [
{
"DisplayName": "Example",
"Value": "string"
}
]
}
],
"TotalItemsCount": 0
}Retrieves a single system email
Parameters
idinteger · pathrequired
System email id.
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Technical name of the system sheet.
DeliveryOptionenum
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages. Possible values: SendAlways, NeverSend, SendOnlyFirstRecurringPayment.Possible values: SendAlwaysNeverSendSendOnlyFirstRecurringPayment
EmailTemplateIdinteger
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages.
FromNamestring · nullable
This is the sending name of the email sent to the recipient.
FromEmailstring · nullable
This is the sending email address of the email sent to the recipient.
Subjectstring · nullable
This is the subject line of the email sent to the recipient.
Bodystring · nullable
This is the body content of the email sent to the recipient.
SystemEventenum
The key parameter that links this letter to the system code. Possible values: PasswordRetrieveEmail, RestoreAdminUserPassword, InviteAdminUser, AdminResetMemberPassword, Invoice, OrderStatusChanged, Quote, GiftVoucher, DropShipping, FirstCartRecoveryEmail, SecondCartRecoveryEmail, LowStockNotification, InvoiceEcom, SupplierNotification, OfflineCreditCardPayment, DoubleOptInEmail, SecureZoneLoginDetails, AffiliateProgramDetails, Forums, ForumsSubscriberAlertforNewPosts, ForumsSubscriberAlertforNewTopics, CustomerServiceTicketing, WorkflowNotification, ThirdrdPartyWorkflowEmails, WorkflowTask, WorkflowCompletion, WorkflowReminder, WorkflowEscalation, WorkflowRejection, ConfirmEmailNotification, OrderStatus, TellAFriend, StorageLimitNotification, FollowUpNotification, AbandonedCartNotification, ItemsLimitNotification, CrmLimitNotification, RecurringReminderNotification.Possible values: PasswordRetrieveEmailRestoreAdminUserPasswordInviteAdminUserAdminResetMemberPasswordInvoiceOrderStatusChangedQuoteGiftVoucherDropShippingFirstCartRecoveryEmailSecondCartRecoveryEmailLowStockNotificationInvoiceEcomSupplierNotificationOfflineCreditCardPaymentDoubleOptInEmailSecureZoneLoginDetailsAffiliateProgramDetailsForumsForumsSubscriberAlertforNewPostsForumsSubscriberAlertforNewTopicsCustomerServiceTicketingWorkflowNotificationThirdrdPartyWorkflowEmailsWorkflowTaskWorkflowCompletionWorkflowReminderWorkflowEscalationWorkflowRejectionConfirmEmailNotificationOrderStatusTellAFriendStorageLimitNotificationFollowUpNotificationAbandonedCartNotificationItemsLimitNotificationCrmLimitNotificationRecurringReminderNotification
DeliveryOptionsarray of objects
List of all available delivery modes for selection in the admin panel.
DisplayNamestring · nullable
A clear name for the administrator.
Valuestring · nullable
The technical value that is recorded in the DeliveryOption field.
curl "https://your-site.webinone.com/api/v2/admin/system-emails/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/system-emails/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/system-emails/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-emails/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-emails/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"DeliveryOption": "SendAlways",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"SystemEvent": "PasswordRetrieveEmail",
"DeliveryOptions": [
{
"DisplayName": "Example",
"Value": "string"
}
]
}Updates an existing system email
Parameters
idinteger · pathrequired
Existent system email id.
Body parameters
Namestringrequired
Technical name of the system sheet.
FromNamestringrequired
This is the sending name of the email sent to the recipient.
FromEmailstringrequired
This is the sending email address of the email sent to the recipient. If using a non-verified email domain you'll see a warning message.
Subjectstringrequired
This is the subject line of the email sent to the recipient.
EmailTemplateIdinteger
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages.
Bodystringrequired
This is the body content of the email sent to the recipient.
DeliveryOptionenumrequired
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages. Possible values: SendAlways, NeverSend, SendOnlyFirstRecurringPayment.Possible values: SendAlwaysNeverSendSendOnlyFirstRecurringPayment
Response
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Technical name of the system sheet.
DeliveryOptionenum
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages. Possible values: SendAlways, NeverSend, SendOnlyFirstRecurringPayment.Possible values: SendAlwaysNeverSendSendOnlyFirstRecurringPayment
EmailTemplateIdinteger
Templates are used as a wrapper for the system email and are handy for setting a single, consistant layout for different content/messages.
FromNamestring · nullable
This is the sending name of the email sent to the recipient.
FromEmailstring · nullable
This is the sending email address of the email sent to the recipient.
Subjectstring · nullable
This is the subject line of the email sent to the recipient.
Bodystring · nullable
This is the body content of the email sent to the recipient.
SystemEventenum
The key parameter that links this letter to the system code. Possible values: PasswordRetrieveEmail, RestoreAdminUserPassword, InviteAdminUser, AdminResetMemberPassword, Invoice, OrderStatusChanged, Quote, GiftVoucher, DropShipping, FirstCartRecoveryEmail, SecondCartRecoveryEmail, LowStockNotification, InvoiceEcom, SupplierNotification, OfflineCreditCardPayment, DoubleOptInEmail, SecureZoneLoginDetails, AffiliateProgramDetails, Forums, ForumsSubscriberAlertforNewPosts, ForumsSubscriberAlertforNewTopics, CustomerServiceTicketing, WorkflowNotification, ThirdrdPartyWorkflowEmails, WorkflowTask, WorkflowCompletion, WorkflowReminder, WorkflowEscalation, WorkflowRejection, ConfirmEmailNotification, OrderStatus, TellAFriend, StorageLimitNotification, FollowUpNotification, AbandonedCartNotification, ItemsLimitNotification, CrmLimitNotification, RecurringReminderNotification.Possible values: PasswordRetrieveEmailRestoreAdminUserPasswordInviteAdminUserAdminResetMemberPasswordInvoiceOrderStatusChangedQuoteGiftVoucherDropShippingFirstCartRecoveryEmailSecondCartRecoveryEmailLowStockNotificationInvoiceEcomSupplierNotificationOfflineCreditCardPaymentDoubleOptInEmailSecureZoneLoginDetailsAffiliateProgramDetailsForumsForumsSubscriberAlertforNewPostsForumsSubscriberAlertforNewTopicsCustomerServiceTicketingWorkflowNotificationThirdrdPartyWorkflowEmailsWorkflowTaskWorkflowCompletionWorkflowReminderWorkflowEscalationWorkflowRejectionConfirmEmailNotificationOrderStatusTellAFriendStorageLimitNotificationFollowUpNotificationAbandonedCartNotificationItemsLimitNotificationCrmLimitNotificationRecurringReminderNotification
DeliveryOptionsarray of objects
List of all available delivery modes for selection in the admin panel.
DisplayNamestring · nullable
A clear name for the administrator.
Valuestring · nullable
The technical value that is recorded in the DeliveryOption field.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/system-emails/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","FromName":"Example","FromEmail":"user@example.com","Subject":"string","EmailTemplateId":1,"Body":"string","DeliveryOption":"SendAlways"}'
await fetch("https://your-site.webinone.com/api/v2/admin/system-emails/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EmailTemplateId": 1, "Body": "string", "DeliveryOption": "SendAlways" }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/system-emails/1", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EmailTemplateId": 1, "Body": "string", "DeliveryOption": "SendAlways" } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/system-emails/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'FromName' => 'Example', 'FromEmail' => 'user@example.com', 'Subject' => 'string', 'EmailTemplateId' => 1, 'Body' => 'string', 'DeliveryOption' => 'SendAlways' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/system-emails/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"FromName\":\"Example\",\"FromEmail\":\"user@example.com\",\"Subject\":\"string\",\"EmailTemplateId\":1,\"Body\":\"string\",\"DeliveryOption\":\"SendAlways\"}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"DeliveryOption": "SendAlways",
"EmailTemplateId": 1,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"SystemEvent": "PasswordRetrieveEmail",
"DeliveryOptions": [
{
"DisplayName": "Example",
"Value": "string"
}
]
}Retrieves a restore to default
Parameters
idstring · pathrequired
Resource identifier.
Response
curl "https://your-site.webinone.com/api/v2/admin/system-emails/restore-to-default/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/system-emails/restore-to-default/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/system-emails/restore-to-default/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-emails/restore-to-default/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-emails/restore-to-default/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
"string"
Retrieves a single system email variables
Parameters
systemEventstring · query
SystemEvent.
Response
curl "https://your-site.webinone.com/api/v2/admin/system-emails/variables" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/system-emails/variables", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/system-emails/variables", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/system-emails/variables', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/system-emails/variables"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[ "string" ]