v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Background Jobs

Cancel a background job

<small>Requires the other:operate scope (or a broader one that includes it).</small>

Requests cancellation of a background job. Idempotent — cancelling an already-terminal job returns 204 without effect on the worker. The request body is optional; if provided, the reason is recorded alongside the cancellation event.

post/v3/background-jobs/{jobId}/cancel

Path parameters

jobIdstring uuid required

Background job identifier (must be a non-empty GUID)

Request body

reasonstring nullable

Optional human-readable reason for the cancellation, recorded with the job

Response

Cancellation requested successfully (or already cancelled — idempotent)