v4
latestOpenAPI 3.0.32026-08-024840393.1 KBpatch/v1/print-jobs/{id}/status
Path parameters
idstring required
Request body
status'QUEUED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'ERROR' | 'RETRYING' | 'PAUSED' | 'CANCELLED' required
organizationIdstring
Organization ID (optional, defaults to user's primary organization)
reasonstring
Reason for the status change (required when setting to CANCELLED or FAILED)
force_downloadboolean
When re-queuing, set force_download on print_options
forceboolean
Force-cancel: skip printer stop command and write DB directly (escape hatch for Pulse outages)
error_codestring
Machine-readable error code to persist on the job (used when transitioning to error/failed/cancelled)
error_messagestring
Human-readable error description to persist on the job for end-user visibility
retry_handoff_expires_atstring date-time
Exact retry handoff lease, or explicit null for an unleased claim
release_printer_readyboolean
Atomically mark the claimed printer ready while re-queuing, fenced by this job's lock ownership
claim_generationstring uuid
Immutable generation returned by the claim being released
expected_printer_idstring uuid
Printer owned by the claim being released
Response
Default Response
successboolean
forcedboolean