Jobs

Cancels a job, returning its materials to stock.

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.

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

Path parameters

idinteger required

Job id from a list response.

Request body

reasonstring nullable

Why the job is being cancelled (recorded on the job; "No reason provided" when omitted).

issueStoreCreditboolean

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

Job id, confirmation message and an optional warning.

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

No recorded changes to this operation across all 1 revision of this API.