Queue API
The queue holds all outgoing emails — pending, sent, canceled, and failed. All endpoints require authentication.
Queue item object
| Field | Type | Description |
|---|---|---|
queue_id | Int | Unique identifier (read-only) |
trigger_id | Int | Trigger that generated this item |
chain_id | Int | Chain that generated this item |
status | String | Current status: pending, sent, canceled, unsubscribed, error, missed |
scheduled_at | String | When the email is scheduled to send |
sent_at | String | When the email was actually sent (empty if not yet sent) |
recipient_email | String | Recipient email address |
recipient_name | String | Recipient display name |
sender_email | String | Sender email address |
sender_name | String | Sender display name |
subject | String | Email subject |
content | String | Rendered HTML content |
history | String | Processing log entries |
uniq_key | String | Deduplication key combining email, trigger, and chain |
uniq_hash | String | SHA-256 hash of the deduplication key |
args_serialized | String | JSON-encoded trigger arguments used to render this email |
attemtps_number | Int | Number of send attempts (note: field name has a typo — two t's) |
created_at | String | Creation timestamp (read-only) |
updated_at | String | Last update timestamp (read-only) |
List queue items
GET /rest/V1/mst-email/queue
Filter by status to monitor pending emails:
GET /rest/V1/mst-email/queue
?searchCriteria[filter_groups][0][filters][0][field]=status
&searchCriteria[filter_groups][0][filters][0][value]=pending
&searchCriteria[filter_groups][0][filters][0][condition_type]=eq
Supports filtering and pagination.
Get queue item
GET /rest/V1/mst-email/queue/:id
Response:
{
"queue_id": 1042,
"trigger_id": 5,
"chain_id": 12,
"status": "pending",
"scheduled_at": "2026-06-11 10:00:00",
"sent_at": "",
"recipient_email": "[email protected]",
"recipient_name": "John Doe",
"sender_email": "[email protected]",
"sender_name": "My Store",
"subject": "You left something behind, John!",
"content": "<!DOCTYPE html>...",
"history": "",
"attemtps_number": 0,
"created_at": "2026-06-10 08:00:00",
"updated_at": "2026-06-10 08:00:00"
}
Errors: 404 queue item not found.
Cancel queue item
Cancels a pending email so it will not be sent.
POST /rest/V1/mst-email/queue/:id/cancel
No request body required.
Response: the updated queue item object with status set to "canceled".
Errors: 404 not found.
Reset queue item
Resets a failed or canceled item back to pending for re-processing.
POST /rest/V1/mst-email/queue/:id/reset
No request body required.
Response: the updated queue item object with status set to "pending".
Errors: 404 not found.
Send queue item immediately
Forces an immediate send, bypassing the scheduled time.
POST /rest/V1/mst-email/queue/:id/send
No request body required.
Response: the updated queue item object with status set to "sent".
Errors: 404 not found.
Delete queue item
DELETE /rest/V1/mst-email/queue/:id
Response:
true
Errors: 404 not found.