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

Ends the test: queued runs are cancelled and their credits refunded, a run that is sending stops sending, and no new run starts. Results for emails already sent are still collected. A stopped test cannot be resumed. The response is the test as List Deliverability Tests shows it, including currentRun.

Path Parameters

string
required
Test ID (UUID)

Query Parameters

string
required
Your SmartLead API key

Response Fields

string
Test ID (UUID). Use it in every /tests/{id} path.
string
Test name
string | null
Test description
string
MANUAL (one run, started now) or AUTO (recurring runs on a schedule)
string
ACTIVE, PAUSED, COMPLETED or STOPPED
string | null
Why the test is in this status, for example USER_PAUSED, USER_STOPPED or SCHEDULE_ENDED
number | null
Folder the test is in
number
Smartlead campaign whose email is tested
number
Sequence step that is tested
number | null
A/B variant tested, or null for the step’s base email
number
Seed inboxes each sender mails per provider
boolean
true when all emails of a run go out together, false when they are spread by sendGapMinutes
number | null
Minutes between emails when they are spread out
boolean
Whether the emails are sent as text only (no HTML)
object | null
AUTO tests: the schedule (see Create Deliverability Test)
string | null
AUTO tests: first run time (ISO 8601)
string | null
AUTO tests: the date after which no run starts
number | null
AUTO tests: the number of runs after which the test completes
string | null
AUTO tests: when the next run starts
number
Runs created so far
string
Creation time (ISO 8601)
object | null
The run still in flight (id, runNo, status, progress and expected result time), or null when none is

Response Codes

Success
Success
Error
Test not found
Error
The test is already finished (INVALID_STATE)
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)