Skip to main content

Update a Job

PATCH /jobs/:key

Can be used to:

Complete the job​

Set the status of the job to completed, with:

  • (optionally) variables

Fail the job​

Set the status of the job to failed, with:

  • retries
  • (optionally) retryBackoff
  • (optionally) errorMessage

Throw an error for the job​

Set the status of the job to error_thrown, with:

  • errorCode
  • (optionally) errorMessage
Path Parameters
  • key int64 required

    Key (unique identifier) of the job to update

Request Body required

A request to update a job

  • status string required

    Requested state for the job, either one of completed, failed, or error_thrown

  • retries int32

    Number of retries for the job when it failed

  • retryBackoff string

    Default value: 0ms

    Duration after which the job becomes activatable again when it failed

  • errorCode string

    Code to match an error catch event when job state error_thrown requested

  • errorMessage string

    Message to describe the error when job state error_thrown requested

  • variables object

    Variables to set for the job

Responses

Successfully updated the job

Schema
  • data
  • error string
Loading...