RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

System Emails API

Retrieve and Update System Emails via the public API endpoint using "where" filtering, and retrieve available template variables. A System Email can also be restored to its default content via this API.

GET System Emails List

Retrieves a list of System Emails as a JSON response based on your provided query parameters.

/api/v2/admin/system-emails

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Semantic_Query
<string>
Min_Score
<double>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "Name": "string",
      "DeliveryOption": "SendAlways",
      "EmailTemplateId": 0,
      "FromName": "string",
      "FromEmail": "user@example.com",
      "Subject": "string",
      "Body": "string",
      "SystemEvent": "PasswordRetrieveEmail",
      "DeliveryOptions": [
        {
          "DisplayName": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "TotalItemsCount": 0
}

GET System Email Item

Retrieves a single System Email based on the ID passed in the endpoint URL.

/api/v2/admin/system-emails/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Name": "string",
  "DeliveryOption": "SendAlways",
  "EmailTemplateId": 0,
  "FromName": "string",
  "FromEmail": "user@example.com",
  "Subject": "string",
  "Body": "string",
  "SystemEvent": "PasswordRetrieveEmail",
  "DeliveryOptions": [
    {
      "DisplayName": "string",
      "Value": "string"
    }
  ]
}

PUT System Email Update

Updates a single System Email based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/system-emails/{id}

Data / Response:

{
  "Name": "string",
  "FromName": "string",
  "FromEmail": "user@example.com",
  "Subject": "string",
  "EmailTemplateId": 0,
  "Body": "string",
  "DeliveryOption": "SendAlways"
}

{
  "Id": 0,
  "Name": "string",
  "DeliveryOption": "SendAlways",
  "EmailTemplateId": 0,
  "FromName": "string",
  "FromEmail": "user@example.com",
  "Subject": "string",
  "Body": "string",
  "SystemEvent": "PasswordRetrieveEmail",
  "DeliveryOptions": [
    {
      "DisplayName": "string",
      "Value": "string"
    }
  ]
}

GET System Email Restore To Default

Restores a single System Email to its default content based on the ID passed in the endpoint URL.

/api/v2/admin/system-emails/restore-to-default/{id}

Data / Response:

N/A

"string"

GET System Email Variables

Retrieves a list of available template variables for a System Email based on the system event type provided.

/api/v2/admin/system-emails/variables

Parameters

Parameter
Values
Required
systemEvent
AdminResetMemberPassword
ConfirmEmailNotification
GiftVoucher
InviteAdminUser
InvoiceEcom
LowStockNotification
OfflineCreditCardPayment
OrderStatus
PasswordRetrieveEmail
Quote
RestoreAdminUserPassword
SecureZoneLoginDetails
StorageLimitNotification
SupplierNotification
WorkflowNotification

Data / Response:

N/A

[
  "string"
]