> ## 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.

# Pause Deliverability Test

> Pause a test

> [!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

Holds the emails of a run that have not gone out yet and, for an `AUTO` test, stops new runs from starting until you resume it. The response is the test as `List Deliverability Tests` shows it, including `currentRun`.

## Path Parameters

**id** `string` *required*

Test ID (UUID)

## Query Parameters

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

Your SmartLead API key

```bash cURL theme={null}
curl -X POST "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/tests/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/pause?api_key=YOUR_KEY"
```

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

API_KEY = "YOUR_API_KEY"

response = requests.post(
    "https://sl-sd-api.smartlead.ai/api/v1/smart-delivery/tests/3f2b8c1e-5d4a-4e7b-9a60-1c2d3e4f5a6b/pause",
    params={"api_key": API_KEY}
)
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/pause?api_key=${API_KEY}`,
  {
    method: 'POST'
  }
);
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)

**currentRun** `object | null`

The run still in flight (`id`, `runNo`, `status`, progress and expected result time), or `null` when none is

## Response Codes

**200** `Success`

Success

**404** `Error`

Test not found

**409** `Error`

Only an active test can be paused, or a manual test has no emails left to send (`INVALID_STATE`)

**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": "PAUSED",
  "statusReason": "USER_PAUSED",
  "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

* [Resume Deliverability Test](https://api.smartlead.ai/api-reference/smart-delivery-v2/resume-test.md)
* [Stop Deliverability Test](https://api.smartlead.ai/api-reference/smart-delivery-v2/stop-test.md)


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