Skip to main content
POST
Smart Delivery v2 (Deliverability Test) API: the deliverability (inbox placement) test that sends your campaign email to seed inboxes and reports where it landed. Contact support@smartlead.ai for access.

Overview

Creates a Smart Delivery v2 (Deliverability Test) test: it sends the chosen sequence email from your sender mailboxes to seed inboxes at the chosen providers, then reports whether each email landed in the inbox, a tab or spam. A MANUAL test starts one run immediately; an AUTO test starts runs on its schedule. Each run uses one run credit. schedule is one of:
  • { "frequency": "DAILY", "timeOfDay": "09:00", "timezone": "America/New_York" }
  • { "frequency": "WEEKLY", "weekdays": [1, 3, 5], "timeOfDay": "09:00", "timezone": "America/New_York" } (weekdays are numbers 1 to 7)
  • { "frequency": "EVERY_N_DAYS", "everyNDays": 3, "timeOfDay": "09:00", "timezone": "America/New_York" } (everyNDays 2 to 90)
timeOfDay is HH:mm (24 hours) and timezone an IANA timezone name.

Query Parameters

string
required
Your SmartLead API key

Body Parameters

string
required
MANUAL (one run, started now) or AUTO (recurring runs)
string
required
Test name, up to 200 characters
string
Up to 2000 characters
number
Folder to put the test in
number
required
Smartlead campaign whose email is tested
number
required
Sequence step to test
number | null
A/B variant to test. Leave out for a step without variants
number[]
required
1 to 20 provider IDs from List Seed Providers, no duplicates
number[]
required
1 to 1000 Smartlead email account IDs to send from. They must be attached to the campaign, and your plan limits how many one test may use (see Get Plan Limits)
boolean
true to send every email of a run together. Set this or sendGap, not both
object
Spread the emails out: { "amount": 10, "unit": "minutes" } with unit one of minutes, hours, days. At least 5 minutes and at most 30 days
boolean
Send the emails as text only (no HTML). Overrides the campaign’s HTML and tracking settings
object
AUTO only, required: when runs start (see below)
string
AUTO only, required: first run time (ISO 8601, in the future)
string
AUTO only: no run starts after this time. Use this or maxRuns, not both
number
AUTO only: stop after this many runs (1 to 1000)

Response Fields

object
The created test
object | null
The first run, for a MANUAL test. null for an AUTO test that starts later.

Response Codes

Success
Success
Error
No Smart Delivery plan, or no run credits left
Error
The campaign or variant does not exist (VARIANT_NOT_FOUND)
Error
Invalid provider (INVALID_PROVIDER), senders not attached to the campaign (INVALID_SENDERS), too many senders for your plan (SENDER_LIMIT), startsAt in the past (STARTS_AT_IN_PAST), or a schedule with no run before endsAt (SCHEDULE_HAS_NO_RUNS)
Unauthorized
Missing, invalid or expired API key (UNAUTHORIZED)
Forbidden
Client (agency) API keys are not allowed (CLIENT_NOT_ALLOWED), or your plan does not include API access (API_ACCESS_RESTRICTED)
Too Many Requests
Too many requests for this API key. Wait the number of seconds in the Retry-After header (RATE_LIMITED)