---
title: "Cancel a bulk job"
description: "Cancels a bulk job that has not finished, as the Bulk actions page does. Work already done stays done (emails already sent are sent); the job stops picking up more invoices."
url: https://docs.invoicefalcon.com/v3-reference/documents/cancel-a-bulk-job/
api: "API v3 reference"
method: POST
path: "/documents/bulk/{job_id}/cancel"
---

# Cancel a bulk job

`POST https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel`

Cancels a bulk job that has not finished, as the Bulk actions page does. Work already done stays done (emails already sent are sent); the job stops picking up more invoices.

**Note:** Emails the job already sent cannot be recalled.

## Path parameters

- `job_id` (string, required)

## Returns

- `job_id` (integer): e.g. `13`
- `kind` (string): e.g. `print`
- `status` (string): e.g. `cancelled`
- `progress` (integer): e.g. `0`
- `count` (integer): e.g. `1`
- `completed` (array of anys)
- `failed` (array of anys)
- `failure_reason` (string, nullable)
- `download_url` (string, nullable)
- `delivery_method` (string): e.g. `print`
- `processing_type` (string, nullable)
- `template_name` (string): e.g. `default`
- `from` (object, nullable)
- `to` (string, nullable)
- `created_at` (string): e.g. `2026-11-10T08:35:18Z`
- `updated_at` (string): e.g. `2026-11-10T08:35:18Z`

Rate limit: this call costs 2 points ([rate limits](https://docs.invoicefalcon.com/v3/docs/api-v3/rate-limits/)).

## Example request

```sh
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/{job_id}/cancel" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
```

## 200

The updated resource.

```json
{
  "job_id": 13,
  "kind": "print",
  "status": "cancelled",
  "progress": 0,
  "count": 1,
  "completed": [],
  "failed": [],
  "failure_reason": null,
  "download_url": null,
  "delivery_method": "print",
  "processing_type": null,
  "template_name": "default",
  "from": null,
  "to": null,
  "created_at": "2026-11-10T08:35:18Z",
  "updated_at": "2026-11-10T08:35:18Z"
}
```

## 401

Missing or unknown `X-Auth-Token`, or the shop uninstalled the app.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "unauthorized"
}
```

## 403

`v3_required`: the shop still runs the previous dashboard. `paid_plan_required`: API access needs a paid plan.

```json
{
  "errors": [
    "API access requires a paid plan"
  ],
  "code": "paid_plan_required"
}
```

## 404

The resource does not exist for this shop, or no action is registered at this path.

```json
{
  "errors": [
    "Resource not found"
  ],
  "code": "not_found"
}
```

## 409

The request conflicts with the current state (an issued invoice is locked, the next invoice number moved, a template is still in use, a job already finished). Nothing was changed.

```json
{
  "errors": [
    "This shop keeps issued invoices unchanged, so this invoice cannot be edited."
  ],
  "code": "invoice_locked"
}
```

## 422

The request failed validation. Nothing was saved.

```json
{
  "errors": [
    "id is missing"
  ]
}
```

## 429

Rate limited: cost-weighted per key (reads cost less than writes). Wait `Retry-After` seconds; see `X-RateLimit-*` headers.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited"
}
```

