Update key result (create update)

Base URL for this request

Select the server matching your Jira Cloud data residency from the Servers drop-down before making requests:

Creates an update for the specified key result. status: displayed values NOT STARTED, ON TRACK, AT RISK, OFF TRACK. newValue: progress to record on this update — not allowed for auto key results (progress from linked work items). For currency units, send a plain number (no currency symbol). description appears on the created update.

Body Params

JSON body. keyResultId required; status, newValue, description optional where allowed.

Key result update request. status uses displayed labels; newValue only for manual (non-auto) key results.

string
required

ID of the key result to add an update for

string
enum

New displayed status: NOT STARTED, ON TRACK, AT RISK, OFF TRACK

Allowed:
double

Progress value on this update (numeric). Omit for auto key results — their value comes from linked work items.

string

Text shown on the created update

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json