Step 1. Create a draft test.
{ "name": "create_scheduled_test", "arguments": {} }
# -> { "id": "9b1c7e84-...", "status": "draft", "inbox_address": "test-9b1c7e84@inbox.unspam.email" }
Step 2. Send the email you want to test to the returned inbox_address, then poll until the template is captured.
{ "name": "get_scheduled_test", "arguments": { "id": "9b1c7e84-..." } }
# Wait until email_subject / email_from are no longer null.
Or skip steps 2 entirely and set the template directly from content with set_scheduled_test_email:
{
"name": "set_scheduled_test_email",
"arguments": {
"id": "9b1c7e84-...",
"subject": "Welcome to our newsletter",
"html": "<h1>Hello!</h1><p>Thanks for subscribing.</p>",
"from": "news@yourdomain.com",
"headers": {
"Reply-To": "support@yourdomain.com",
"List-Unsubscribe": "<https://yourdomain.com/unsubscribe?id=123>",
"List-Unsubscribe-Post": "List-Unsubscribe=One-Click"
}
}
}
Step 3. Configure the test. Use a sender id as sender_uuid and mailbox IDs from list_mailboxes as providers.
{
"name": "configure_scheduled_test",
"arguments": {
"id": "9b1c7e84-...",
"name": "My automatic test",
"status": "active",
"sender_uuid": "2ded86a5-...",
"providers": [3, 7, 23],
"schedule": { "start_at": "2026-06-18T10:21:00Z", "type": "week", "days": [] },
"alert_settings": { "mode": "all", "spam_level": null }
}
}
Schedule type is one of month, week, days, or specific_days; days (0–6) is required only for specific_days. Alert mode is all or spam_level; spam_level (0–100) is required only for spam_level.
Step 4. Trigger a run now (optional), then fetch its result.
{ "name": "dispatch_scheduled_test", "arguments": { "id": "9b1c7e84-..." } }
# -> { "status": "in_queue", "run_id": "f47ac10b-..." }
{ "name": "get_scheduled_test_run", "arguments": { "id": "9b1c7e84-...", "run_id": "f47ac10b-..." } }