Pause a bulk job

Controls remaining bulk-job work with a mandatory expectedVersion fence and current resolved-action authorization. Already-started items may finish; completed callbacks and history remain. This does not pause the selected schedules.

post/v1/bulk/jobs/{jobId}/pause

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/bulk/jobs/{jobId}/pause
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Path parameters

jobIdstring required

Request body

expectedVersioninteger required

Response

Pause a bulk job

idstring required
state'preparing' | 'awaiting_confirmation' | 'queued' | 'running' | 'paused' | 'blocked' | 'completed' | 'completed_with_failures' | 'cancelled' | 'expired' | 'refused' required
versioninteger required
createdAtstring required
updatedAtstring required
referenceAtstring required
preparationExpiresAtstring required
previewExpiresAtstring
executionExpiresAtstring
resultsExpireAtstring
intentDigeststring
completeboolean required
warningsstring[] required
reason'eligible' | 'already_active' | 'already_paused' | 'already_cancelled' | 'invalid_state' | 'unsupported_target' | 'expired_input' | 'unauthorized' | 'concurrently_changed' | 'past_time' | 'attempt_limit' | 'operation_failed' | 'transient_failure' | 'selection_too_large' | 'preparation_incomplete' | 'preview_expired' | 'job_expired' | 'job_cancelled' | 'quota_exceeded' | 'spending_limit' | 'in_flight'

Changes

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