---
title: "Cancels a job, returning its materials to stock."
method: POST
path: "/api/v1/jobs/{id}/cancel"
tags: ["Jobs"]
---

# Cancels a job, returning its materials to stock.

`POST /api/v1/jobs/{id}/cancel`

## Request

- Base URL: `https://app.flexonthejob.com`
- URL: `https://app.flexonthejob.com/api/v1/jobs/{id}/cancel`
- Auth: HTTP bearer

Same rules as the UI: a job that has received payment, or has sent/paid invoices,
cannot be cancelled until the money is refunded / invoices voided (409). A job with
an uncollected down payment can be cancelled with `issueStoreCredit: true`
when the key holds `ManageStoreCredit`. Cancelling an already-cancelled job
answers 200 with a `warning`. Requires an `Idempotency-Key` header.

## Path parameters

- `id` integer, required

## Request body

- CancelJobRequest: Body of `POST /api/v1/jobs/{id}/cancel`.
  - `reason` string, nullable: Why the job is being cancelled (recorded on the job; "No reason provided" when omitted).
  - `issueStoreCredit` boolean: When the job holds an uncollected down payment, convert it to customer store credit instead of blocking the cancellation. Requires the key to hold `ManageStoreCredit`.

## Response `200`

Job id, confirmation message and an optional warning.

- ApiOperationResponse: Body of a successful workflow-style write that has no richer resource to return (assign, start, complete, void…). Id is the affected resource's id; Warning carries a non-fatal note from the service (e.g. an email that could not be sent).
  - `id` integer: Id of the resource the operation acted on (e.g. the job id).
  - `message` string, nullable: Human-readable confirmation from the service (e.g. "Job started."). May be null.
  - `warning` string, nullable: Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

## Other responses

- `400`: Malformed body or missing `Idempotency-Key`.
- `401`: Unauthorized
- `403`: Forbidden
- `404`: No such job in this organization.
- `409`: Payments or invoices block the cancellation, or the key's creator is unknown on this server.
- `429`: Too Many Requests

---

[API](https://skmtc.dev/flexonthejob/apis/flex-api.md) · [All operations](https://skmtc.dev/flexonthejob/apis/flex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flexonthejob/apis/flex-api/revisions/19c8f4d27acf?raw)