Skip to main content
PATCH
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

Send only the fields you want to change. At least one field is required. 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.

Path Parameters

string
required
Test ID (UUID)

Query Parameters

string
required
Your SmartLead API key

Body Parameters

string
New name
string | null
New description, or null to clear it
number | null
Folder ID, or null to take the test out of its folder
object
AUTO tests only: the new schedule
boolean
Send every email of a run together
object
{ "amount": 10, "unit": "minutes" }. Not together with sendAllAtOnce: true

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)

Response Codes

Success
Success
Error
Test or folder not found
Error
Only AUTO tests have a schedule (INVALID_STATE)
Error
The new schedule has 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)