Skip to content

by Startups.Studio

Growth Goal Minimum Success Criteria

MinimumSuccessCriteria.update

PATCH /{namespace}/minimum-success-criteria/{id}

Changes the given properties of a Minimum Success Criteria.

Noun: Minimum Success Criteria
Mode: do
Event: MinimumSuccessCriteria.updated

You, to your agent

Change the latest minimum success criteria.

curl -X PATCH https://api.sb/shiftnote.app/minimum-success-criteria/minimum_success_criteria_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"metric":"metric_1"}'

import { $ } from 'startup-builder'

const minimumSuccessCriteria = await $.MinimumSuccessCriteria.update({ id: 'minimum_success_criteria_1', metric: 'metric_1' })

npx startup-builder do MinimumSuccessCriteria.update --json '{"id":"minimum_success_criteria_1","metric":"metric_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.MinimumSuccessCriteria.update({ id: 'minimum_success_criteria_1', metric: 'metric_1' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Minimum Success Criteria.
`objective`	`text`		The qualitative outcome.
`horizon`	`string`		One of `day`, `week`, `quarter`, `year`, or `three-years`.
`metric`	Metric		The Metric the number is measured in.
`value`	`number`		The number to reach.
`by`	`date`		The date it must be reached.
`fermi`	`json`		The Price, rates and volumes that show the number is reachable.

Outputs

Output	Type	Required	Description
`minimumSuccessCriteria`	Minimum Success Criteria	required	The Minimum Success Criteria.

Effects

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

MinimumSuccessCriteria.list

Previous Page

Handle

Next Page