Skip to content

by Startups.Studio

Goal.update

PATCH /{namespace}/goals/{id}

Changes the given properties of a Goal.

Noun: Goal
Mode: do
Event: Goal.updated

You, to your agent

Change the latest goal.

curl -X PATCH https://api.sb/kilnbakery.com/goals/goal_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"horizon":"day"}'

import { $ } from 'startup-builder'

const goal = await $.Goal.update({ id: 'goal_1', horizon: 'day' })

npx startup-builder do Goal.update --json '{"id":"goal_1","horizon":"day"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Goal.update({ id: 'goal_1', horizon: 'day' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Goal.
`objective`	`text`		The qualitative outcome.
`horizon`	`string`		One of `day`, `week`, `quarter`, `year`, or `three-years`.

Outputs

Output	Type	Required	Description
`goal`	Goal	required	The Goal.

Effects

Emits Goal.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.	Goal.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`.

Goal.list

Previous Page

Minimum Success Criteria

Next Page