Skip to main content
PATCH
Update a key result
Changes a key result’s title, targetValue, currentValue (progress), unit or status (ON_TRACK, AT_RISK, BEHIND or COMPLETE). Send id plus at least one field; omitted fields are unchanged. An unknown or malformed id is 404 resource_missing; omitting id is 400 bad_request. The credential needs both the objectives:read and objectives:manage scopes, and objectives:read and objectives:manage granted at the deployment root; otherwise 403 permission_denied names the missing permission. The body is strict: unknown fields are 400 bad_request. Success is 200 with the post-write KeyResult. A same-key retry within 24 hours returns the recorded result while the caller still holds both permissions at the deployment root.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

keyResultId
string
required

The key result ID, as the objective reads return it.

Minimum string length: 1

Body

application/json

The fields to change, including progress (currentValue) and status. At least one field besides id is required. Unknown fields are refused.

title
string

Stored exactly as sent; at most 200 characters and not blank.

Maximum string length: 200
targetValue
number

The value that completes the key result.

currentValue
number

The progress recorded so far.

unit
string

The measurement unit, at most 32 characters.

Maximum string length: 32
status
enum<string>
Available options:
ON_TRACK,
AT_RISK,
BEHIND,
COMPLETE

Response

Update a key result

data
object
required
meta
object
required