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. Requires reason (why the record is being changed); 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 reason is missing or blank. 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

Unique identifier of the team (organization). Format: Revenium hashid (URL-safe encoded string).

Body Params

Request to update a previously reported job outcome

string | null
required

Reason this outcome record is being changed (required for the audit trail). Not the same as outcomeReason, which explains the job's own failure.

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.

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