InboxAlly provides a REST API that gives you programmatic access to your seeds, sender profiles, and broadcast data. If you manage multiple accounts, build custom dashboards, or want to automate tasks like seed shuffling or engagement rule changes, the API is how you do it.
The full interactive API reference with request/response examples lives at apidocs.inboxally.com. This article explains what the API can do, how to authenticate, and how to get started.
Who Should Use the API
The API is built for:
- Agencies and resellers managing sender profiles across multiple client domains
- Developers building internal tools or custom integrations with InboxAlly
- Platforms integrating InboxAlly functionality natively into their own product
- Power users who want to automate seed shuffling, engagement tuning, or reporting
If you just need to add seed emails to your ESP, you do not need the API — see How to Use InboxAlly with Any Email Platform for the simpler approach. For platforms with native integrations like Klaviyo or HubSpot, those handle connectivity automatically.
Authentication
All API requests require an API key sent in the request header.
Where to find your API key:
- Log in to your InboxAlly account.
- Go to My Account → API.
- Copy your API key.
How to authenticate:
Include your key in the X-API-KEY header on every request:
X-API-KEY: your-api-key-here
All requests go to https://api.inboxally.com.
API keys are account-scoped — they provide full access to your account's resources. Keep them secure and never embed them in client-side code or public repositories.
API Capabilities
The API is organized into three resource groups: Seeds, Senders, and Broadcasts.
Seeds
Manage your seed email addresses and control seed shuffling.
Retrieve seeds:
- List all seeds with filtering by status (active, inactive, or all)
- Get details for a specific seed by email address
- Supports pagination for large seed lists
Shuffle seeds:
- Trigger a shuffle to replace seed addresses with fresh ones from InboxAlly's pool
- Check shuffle status to see if a shuffle is currently allowed (there is a 30-day cooldown between shuffles)
- View your last shuffle details and full shuffle history
Three shuffle methods are available via API:
| Method | What it does |
|---|---|
in_place |
Shuffles a percentage of all seeds while keeping the same provider mix (e.g., 60% Gmail, 20% Yahoo stays the same) |
in_place_by_provider |
Shuffles different percentages per provider — for example, replace 75% of Gmail seeds but only 25% of Gsuite seeds |
custom |
Shuffles seeds and redistributes them to a completely new provider mix |
For a full walkthrough of seed shuffling (including the UI method), see How to Shuffle Your InboxAlly Seed Emails.
Senders (Sender Profiles)
Create, update, and manage your sender profiles and their engagement rules.
Retrieve sender profiles:
- List all sender profiles with filtering by status, tag, domain, creation date, or recent activity
- Get sender profiles by domain or by tag for bulk operations
Create and update:
- Create new sender profiles with engagement rules
- Update sender profile details
- Change sender status (active/inactive) individually, by domain, or by tag
Engagement rules:
The API lets you set and change engagement rules on sender profiles. Available engagement presets:
| Preset | Use case |
|---|---|
default |
Standard engagement for healthy senders |
warmup |
Higher engagement signals for new or cold domains |
repair |
Aggressive engagement to recover damaged reputation |
boost |
Elevated engagement for a temporary push |
protect |
Maintenance-level engagement for established senders |
custom |
Set your own percentages for each engagement type |
With custom engagement, you control the percentage for each action: open, scroll down, spam-to-inbox, promo-to-inbox, mark important, reply, and click link.
You can update engagement rules on individual sender profiles, or in bulk by domain or tag.
Broadcasts
Pull placement and deliverability data for your email campaigns.
Retrieve broadcast data:
- List recent broadcasts with placement breakdowns: total emails, primary inbox, promotions, spam, and inboxing percentage
- Filter by email provider (Gmail, Yahoo, GSuite, Hotmail, Outlook, MS365) or by sender (from_email)
- Get detailed data for a specific broadcast by ID
Broadcasts are auto-grouped by subject, sender, and arrival date. This is the same data you see on your InboxAlly Dashboard — the API lets you pull it into your own systems.
Pagination
The API uses cursor-based pagination for endpoints that return lists. Use the limit parameter to control page size and page_token to navigate through results. The response includes a next_page_token value when more results are available.
Getting Started
- Generate your API key in the InboxAlly dashboard under My Account → API.
- Review the full API reference at apidocs.inboxally.com. The docs are interactive (Stoplight-powered) with request and response examples for every endpoint.
-
Make a test request to verify your key works. Good starting points:
-
GET /v3/seeds— list your seed email addresses -
GET /v3/senders— list your sender profiles -
GET /v3/broadcasts— list recent broadcasts with placement data
-
- Build from there based on your use case.
Common Use Cases
Agency and reseller management:
Manage sender profiles across multiple client domains via API. Bulk-update engagement rules by domain or tag — for example, switch all senders on a client's domain from warmup to default once placement stabilizes.
Custom reporting dashboards:
Pull broadcast data (inboxing percentage, primary/promo/spam breakdown by provider) into your own reporting tools or client-facing dashboards.
Automated seed shuffling:
Schedule a monthly shuffle via a cron job using the shuffle trigger endpoint. Check cooldown status first, trigger the shuffle with your preferred method, then fetch the updated seed list to sync to your ESP.
ESP integration:
Fetch your seed list programmatically to sync into platforms that do not have a native InboxAlly integration. Automate the import process so seeds stay current without manual effort.
Engagement tuning:
Programmatically switch sender profiles between engagement presets based on performance. For example, if a sender's inboxing rate drops below a threshold, automatically switch from default to repair.
Rate Limits
The API enforces rate limits to ensure stability. If you hit a limit, the response will include a Retry-After header indicating when you can make your next request. For most use cases — checking broadcasts, syncing seeds, updating sender profiles — you will not encounter rate limits.
Full API Reference
The complete interactive documentation is at apidocs.inboxally.com. Every endpoint includes request parameters, example payloads, and response schemas.
For API-specific questions, contact support@inboxally.com.