Sign in

patch/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

Changes

Changed in 2 of the 24 revisions of this API.6

  • 4a0fbdd6e87d4See the full diff
    • ○

      added the new optional request property claim_generation

      new-optional-request-property

    • ○

      added the new optional request property expected_printer_id

      new-optional-request-property

    • ○

      added the new optional request property release_printer_ready

      new-optional-request-property

    • ○

      request property retry_handoff_expires_at list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

  • 750c8a1363072See the full diff
    • ○

      added the new optional request property retry_handoff_expires_at

      new-optional-request-property

    • ○

      added the non-success response with the status 409

      response-non-success-status-added