Sign in
Jobs

Sets a job's result

Sets a specific job's result. The job status must be started to use this endpoint (required scope jobs:write)

put/v1/jobs/{jobId}/result

Path parameters

jobIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

status'completedOk' | 'completedWithIssues' required

Describes the result of a job<p>Possible values:</p><ul><li><b>completedOk</b>: Job completed with a positive result</li><li><b>completedWithIssues</b>: Job completed with a negative result</li></ul>

resultstring nullable

Required if status is completedOk; optional if completedWithIssues. Must exactly match a valid result string for the job type and status

statusModifiedAtstring date-time nullable

The UTC timestamp the status change should be recorded at. If omitted the current UTC time is used

Example request

{
  "status": "completedOk",
  "result": "complete",
  "statusModifiedAt": "2025-01-05T14:23:10.0000000+00:00"
}

Response

No Content