# Cancel a bulk job

`POST /api/v1/email/bulk/{jobId}/cancel`

- Authentication: Secret API key as a bearer token
- Billing: Free.
- Group: Bulk

Asks a queued or running job to stop. A queued job is cancelled on the spot; a running one stops at its next checkpoint and keeps the rows already written downloadable through the results endpoint. Rows already verified stay billed. The completion webhook fires with status `cancelled` just as it does for `completed` and `failed`. A job that already reached a terminal status answers `409 JOB_ALREADY_FINISHED`.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `jobId` | path | integer | yes | The id returned at creation. |

## Example request

```bash
curl -X POST https://spaw.co/api/v1/email/bulk/512/cancel \
  -H "Authorization: Bearer sk_live_…"
```

## Responses

### 200 — The job, with `cancel_requested` set.

```json
{
    "success": true,
    "data": {
        "job": {
            "id": 512,
            "status": "processing",
            "total": 2000,
            "duplicate_count": 12,
            "processed": 900,
            "deliverable": 610,
            "risky": 140,
            "undeliverable": 150,
            "credits_used": 750,
            "stopped_reason": null,
            "cancel_requested": true,
            "webhook_status": null,
            "created_at": "2026-09-03T10:12:44+00:00",
            "finished_at": null
        }
    }
}
```

### 401 — The key is missing, malformed, or revoked.

```json
{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

### 404 — No such record on this account.

```json
{
    "message": "Not Found"
}
```

### 409 — The job already finished.

```json
{
    "success": false,
    "error": {
        "code": "JOB_ALREADY_FINISHED",
        "message": "The job has already finished and cannot be cancelled.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

### 429 — Over 5 requests per second for the key. Retry after the limit resets.

```json
{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}
```

## Error codes

- `UNAUTHENTICATED` — https://spaw.co/docs/errors/UNAUTHENTICATED
- `JOB_ALREADY_FINISHED` — https://spaw.co/docs/errors/JOB_ALREADY_FINISHED
- `RATE_LIMITED` — https://spaw.co/docs/errors/RATE_LIMITED

---

Canonical page: https://spaw.co/docs/api/cancel-bulk-job · OpenAPI document: https://spaw.co/openapi.json · All endpoints: https://spaw.co/docs/api