Skip to main content
POST
Add a key result
Adds a key result to an existing objective. Send objectiveId, title (1–200 characters), targetValue and optionally unit (up to 32 characters). The key result starts at currentValue: 0 and ON_TRACK. An unknown or malformed objectiveId is 404 resource_missing; omitting it 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 201 with the KeyResult. Without an Idempotency-Key, repeating the call adds a second key result. Reconcile an unknown outcome with List key results.

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

objectiveId
string
required

The objective ID, as the objective reads return it.

Minimum string length: 1

Body

application/json

A key result for an objective; it starts at currentValue 0 and ON_TRACK. Unknown fields are refused.

title
string
required

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

Maximum string length: 200
targetValue
number
required

The value that completes the key result.

unit
string

The measurement unit, at most 32 characters.

Maximum string length: 32

Response

Add a key result

data
object
required
meta
object
required