Skip to content

by Startups.Studio

Growth Key Result

KeyResult.update

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

Changes the given properties of a Key Result.

Noun: Key Result
Mode: do
Event: KeyResult.updated

You, to your agent

Change the latest key result.

curl -X PATCH https://api.sb/patentpad.com/key-results/key_result_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"baseline":1}'

import { $ } from 'startup-builder'

const keyResult = await $.KeyResult.update({ id: 'key_result_1', baseline: 1 })

npx startup-builder do KeyResult.update --json '{"id":"key_result_1","baseline":1}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.KeyResult.update({ id: 'key_result_1', baseline: 1 })"
  }
}

Update changes the given properties of a Key Result. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Key Result.
`baseline`	`number`		Where the Metric started.
`target`	`number`		Where the Metric must reach.
`deadline`	`date`		When it must reach it.

Outputs

Output	Type	Required	Description
`keyResult`	Key Result	required	The Key Result.

Effects

Emits KeyResult.updated.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	KeyResult.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

KeyResult.list

Previous Page

Keyword

Next Page