API Reference
Log In
API Reference

Update Job Outcome

Update the outcome for a job that has already had its outcome reported. For example, correcting a status that an SDK reported wrongly. If you call with a signed-in user's session, include reason (why the outcome is being changed). With an API key, reason is optional; Revenium records an automated correction reason. The update is recorded in the outcome history. outcomeReason (why the job itself failed) is separate and optional: omit it to keep the current value, send an empty string to clear it. Returns 422 if no outcome has been reported yet, or if a session caller omits reason. Optionally send the Job entityVersion as expectedEntityVersion; a stale value returns 409. Returns 409 if a concurrent update conflict is detected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

User-supplied external identifier for the job.

Query Params
string
required

ID of the team that owns this data.

Body Params

Request to update a previously reported job outcome

string | null

Why the outcome is being changed. Required if you call with a signed-in user's session. With an API key it is optional, and Revenium records an automated correction reason. Not the same as outcomeReason, which explains why the job itself failed.

int64 | null

Optional. The entityVersion you last read. If the job changed since then, the request fails with 409 so you do not overwrite someone else's change.

string | null
enum

Updated execution status of the completed job

Allowed:
string | null
enum

Updated business outcome type

Allowed:
number | null

Updated monetary value of the outcome

string | null
enum

Updated currency for the outcome value. Defaults to USD.

string | null

Updated additional outcome metadata as JSON string

string | null

Updated explanation of the outcome: why the job failed or was cancelled. Omit to leave the current value untouched; send an empty string to clear it.

metrics
array of objects | null

Outcome metrics to record along with this change

metrics
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*