---
title: "Cancel the queued items of a batch"
method: POST
path: "/v1/batches/{id}/cancel"
tags: ["Batches"]
---

# Cancel the queued items of a batch

`POST /v1/batches/{id}/cancel`

## Request

- Base URL: `https://api.castpdf.com`
- URL: `https://api.castpdf.com/v1/batches/{id}/cancel`
- Auth: HTTP bearer

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- Batch
  - `id` string, uuid
  - `status` 'queued' | 'processing' | 'completed' | 'canceled'
  - `livemode` boolean
  - `source` 'api' | 'spreadsheet'
  - `template_id` string, uuid
  - `template_version` integer
  - `total` integer
  - `queued` integer
  - `processing` integer
  - `succeeded` integer
  - `failed` integer
  - `canceled` integer
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `zip` object, nullable
    - `url` string, uri
    - `expires_at` string, date-time
    - `bytes` integer
  - `metadata` object, nullable

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/castpdf/apis/castpdf-api.md) · [All operations](https://skmtc.dev/castpdf/apis/castpdf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/castpdf/apis/castpdf-api/revisions/4ec737ba2ba6?raw)