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

Emails API

Create, Retrieve, Update and Delete System Emails (such as Workflow Notification, Follow Up Notification, Abandoned Cart Notification, and Recurring Reminders) via the public API endpoint using "where" filtering, as well as retrieve available Email Custom Groups.

GET Emails List

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

/api/v2/admin/emails

Parameters

Parameter
Values
Required
systemEvent
WorkflowNotification
FollowUpNotification
AbandonedCartNotification
RecurringReminderNotification
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",
      "EmailTemplateId": 0,
      "FromName": "string",
      "FromEmail": "string",
      "Subject": "string",
      "Body": "string",
      "CreatedDateTime": "2026-01-01T00:00:00.000Z",
      "GroupName": "string"
    }
  ],
  "TotalItemsCount": 0
}

POST Email Create

Creates a new Email based on the provided data.

/api/v2/admin/emails

Data / Response:

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

{
  "Id": 0,
  "Name": "string",
  "EmailTemplateId": 0,
  "FromName": "string",
  "FromEmail": "string",
  "Subject": "string",
  "Body": "string",
  "CreatedDateTime": "2026-01-01T00:00:00.000Z",
  "GroupName": "string"
}

GET Email Item

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

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

Data / Response:

N/A

{
  "Id": 0,
  "Name": "string",
  "EmailTemplateId": 0,
  "FromName": "string",
  "FromEmail": "string",
  "Subject": "string",
  "Body": "string",
  "CreatedDateTime": "2026-01-01T00:00:00.000Z",
  "GroupName": "string"
}

PUT Email Update

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

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

Data / Response:

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

{
  "Id": 0,
  "Name": "string",
  "EmailTemplateId": 0,
  "FromName": "string",
  "FromEmail": "string",
  "Subject": "string",
  "Body": "string",
  "CreatedDateTime": "2026-01-01T00:00:00.000Z",
  "GroupName": "string"
}

DELETE Email Delete

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

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

Data / Response:

N/A

Status 204

GET Email Custom Email Groups List

Retrieves a list of Email's Custom Email Groups as a JSON response based on your provided query parameters.

/api/v2/admin/emails/custom-email-groups

Data / Response:

N/A

[
  {
    "Id": "string",
    "Type": "string",
    "DisplayName": "string"
  }
]