This quick guide explains the overall flow — from connecting a mailbox to launching your first Inbox Insights automated test. Use it as a high-level walkthrough to understand how the endpoints fit together.
1️⃣ API Authorization
Before starting, make sure you’ve completed all steps from the API Authorization section.
You’ll need a valid API key to include in the Authorization header for every request.
2️⃣ Connect a Mailbox
Next, create and connect a mailbox using the /mailboxes endpoint.
Once connected successfully, you’ll receive a mailboxId — keep it for later steps.
3️⃣ Create or choose a template
Tests require an email template.
You can either:
- Use an existing template (
templateId), or - Create a new one using the /templates endpoint.
4️⃣ Start an automated test
Launch the test using the /inbox-insights/tests/manual/start endpoint.
This triggers the sending process and begins inbox placement monitoring.
You'll receive the testid in the response. Keep it to fetch test results later.
5️⃣ View test results
Use the /inbox-insights/tests/:id endpoint to retrieve insights about inbox, spam, and promotions folder placement.
✅ Summary
In short, the test flow is:
- Authorize your API key
- Connect a mailbox
- Create or pick a template
- Start an automated test
- Fetch your test results
That’s it — you’ve just completed your first Inbox Insights automated test flow 🎉