Skip to content

Key Result routes: update, delete

The Key Result Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Key Result, one group of Key Result routes.

KeyResult.update

Changes the given properties of a Key Result. Verb page.

Text
PATCH /{namespace}/key-results/{id}

Path: id. Body, as JSON: the other inputs. Emits KeyResult.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Key Result.
baselinenumberWhere the Metric started.
targetnumberWhere the Metric must reach.
deadlinedateWhen it must reach it.

Returns

OutputTypeRequiredDescription
keyResultKey ResultrequiredThe Key Result.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X PATCH https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"baseline":1}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "keyResult": {
    "$id": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
    "$type": "KeyResult",
    "baseline": 1,
    "target": 1,
    "deadline": "2026-10-22"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "KeyResult.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

KeyResult.delete

Deletes a Key Result: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
DELETE /{namespace}/key-results/{id}

Path: id. Emits KeyResult.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Key Result.

Returns

OutputTypeRequiredDescription
keyResultKey ResultrequiredThe Key Result.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X DELETE https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "keyResult": {
    "$id": "https://api.sb/leaseline.app/key-results/kr_fN3pcvG8sq",
    "$type": "KeyResult",
    "baseline": 1,
    "target": 1,
    "deadline": "2026-10-22"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "KeyResult.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}