> ## Documentation Index
> Fetch the complete documentation index at: https://api.smartlead.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Deliverability Test

> Rename a test, move it to a folder, or change its schedule or send timing

> [!NOTE]
>
> **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](mailto: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

**id** `string` *required*

Test ID (UUID)

## Query Parameters

**api\_key** `string` *required*

Your SmartLead API key

## Body Parameters

**name** `string`

New name

**description** `string | null`

New description, or `null` to clear it

**folderId** `number | null`

Folder ID, or `null` to take the test out of its folder

**schedule** `object`

`AUTO` tests only: the new schedule

**sendAllAtOnce** `boolean`

Send every email of a run together

**sendGap** `object`

`{ "amount": 10, "unit": "minutes" }`. Not together with `sendAllAtOnce: true`

```bash cURL theme={null}
curl -X PATCH "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/tests/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b?api_key=YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Q4 Outbound - step 1 (retest)", "folderId": 12}'
```

```python Python theme={null}
import requests

API_KEY = "YOUR_API_KEY"

response = requests.patch(
    "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/tests/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b",
    params={"api_key": API_KEY}, json={"name": "Q4 Outbound - step 1 (retest)", "folderId": 12}
)
print(response.status_code)
print(response.json())
```

```javascript JavaScript theme={null}
const API_KEY = 'YOUR_API_KEY';

const response = await fetch(
  `https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/tests/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b?api_key=${API_KEY}`,
  {
    method: 'PATCH',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({"name": "Q4 Outbound - step 1 (retest)", "folderId": 12})
  }
);
console.log(await response.json());
```

## Response Fields

**id** `string`

Test ID (UUID). Use it in every `/tests/{id}` path.

**name** `string`

Test name

**description** `string | null`

Test description

**type** `string`

`MANUAL` (one run, started now) or `AUTO` (recurring runs on a schedule)

**status** `string`

`ACTIVE`, `PAUSED`, `COMPLETED` or `STOPPED`

**statusReason** `string | null`

Why the test is in this status, for example `USER_PAUSED`, `USER_STOPPED` or `SCHEDULE_ENDED`

**folderId** `number | null`

Folder the test is in

**campaignId** `number`

Smartlead campaign whose email is tested

**sequenceId** `number`

Sequence step that is tested

**variantId** `number | null`

A/B variant tested, or `null` for the step's base email

**seedsPerSenderPerProvider** `number`

Seed inboxes each sender mails per provider

**sendAllAtOnce** `boolean`

`true` when all emails of a run go out together, `false` when they are spread by `sendGapMinutes`

**sendGapMinutes** `number | null`

Minutes between emails when they are spread out

**textOnly** `boolean`

Whether the emails are sent as text only (no HTML)

**schedule** `object | null`

`AUTO` tests: the schedule (see Create Deliverability Test)

**startsAt** `string | null`

`AUTO` tests: first run time (ISO 8601)

**endsAt** `string | null`

`AUTO` tests: the date after which no run starts

**maxRuns** `number | null`

`AUTO` tests: the number of runs after which the test completes

**nextRunAt** `string | null`

`AUTO` tests: when the next run starts

**runsCreated** `number`

Runs created so far

**createdAt** `string`

Creation time (ISO 8601)

## Response Codes

**200** `Success`

Success

**404** `Error`

Test or folder not found

**409** `Error`

Only `AUTO` tests have a schedule (`INVALID_STATE`)

**422** `Error`

The new schedule has no run before `endsAt` (`SCHEDULE_HAS_NO_RUNS`)

**401** `Unauthorized`

Missing, invalid or expired API key (`UNAUTHORIZED`)

**403** `Forbidden`

Client (agency) API keys are not allowed (`CLIENT_NOT_ALLOWED`), or your plan does not include API access (`API_ACCESS_RESTRICTED`)

**429** `Too Many Requests`

Too many requests for this API key. Wait the number of seconds in the `Retry-After` header (`RATE_LIMITED`)

```json 200 - Success theme={null}
{
  "id": "3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b",
  "name": "Q4 Outbound - sequence step 1",
  "description": null,
  "type": "MANUAL",
  "status": "ACTIVE",
  "statusReason": null,
  "folderId": null,
  "campaignId": 5614,
  "sequenceId": 20311,
  "variantId": null,
  "seedsPerSenderPerProvider": 4,
  "sendAllAtOnce": true,
  "sendGapMinutes": null,
  "textOnly": false,
  "schedule": null,
  "startsAt": null,
  "endsAt": null,
  "maxRuns": null,
  "nextRunAt": null,
  "runsCreated": 1,
  "createdAt": "2026-11-17T08:30:00.000Z"
}
```

```json Error - Unauthorized theme={null}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API Key"
  }
}
```

## Related Endpoints

* [Get Deliverability Test](https://api.smartlead.ai/api-reference/smart-delivery-v2/get-test.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.