Skip to main content

REST API

Follow Up Email exposes a REST API that lets you manage campaigns, triggers, chains, templates, and the email queue programmatically — without going through the Magento admin UI.

This is useful when you want to:

  • Automate campaign and trigger setup from deployment scripts or CI/CD pipelines.
  • Integrate with external CRM or marketing platforms.
  • Monitor email queue status and performance data from custom dashboards.
  • Build multi-store email automation tooling on top of Magento.

Base URL​

All endpoints follow Magento's standard REST API pattern:

https://<your-store-domain>/rest/<store-code>/V1/mst-email/

For the default store view use default as the store code, or omit it entirely:

https://<your-store-domain>/rest/V1/mst-email/

Authentication​

All endpoints require an admin Bearer token. Obtain one by calling:

POST /rest/V1/integration/admin/token

Request body:

{
  "username": "admin",
  "password": "your-admin-password"
}

Response:

"abc123xyz..."

Include the token in every subsequent request:

Authorization: Bearer abc123xyz...

Filtering and pagination​

All list endpoints accept Magento's standard searchCriteria query parameters.

Example — list active triggers, newest first:

GET /rest/V1/mst-email/triggers
  ?searchCriteria[filter_groups][0][filters][0][field]=is_active
  &searchCriteria[filter_groups][0][filters][0][value]=1
  &searchCriteria[filter_groups][0][filters][0][condition_type]=eq
  &searchCriteria[sort_orders][0][field]=created_at
  &searchCriteria[sort_orders][0][direction]=DESC
  &searchCriteria[pageSize]=20

List response envelope:

{
  "items": [ ... ],
  "search_criteria": { ... },
  "total_count": 42
}

Endpoints​

  • Available Events — discover event identifiers and their configurable parameters
  • Campaigns — CRUD for email campaigns
  • Triggers — CRUD and management for campaign triggers
  • Chains — CRUD for email chains (scheduled emails within a trigger)
  • Templates — CRUD for email templates
  • Themes — CRUD for email themes
  • Queue — view and manage the outgoing email queue
  • Events — view and manage the event log
  • Unsubscriptions — manage email unsubscriptions
  • Report — read-only reporting data (opens, clicks, orders, reviews, emails)