Skip to content

by Startups.Studio

Story.update

PATCH /{namespace}/stories/{id}

Changes the given properties of a Story.

Noun: Story
Mode: do
Event: Story.updated

You, to your agent

Change the latest story.

curl -X PATCH https://api.sb/petpantry.shop/stories/story_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"icp":"icp_1"}'

import { $ } from 'startup-builder'

const story = await $.Story.update({ id: 'story_1', icp: 'icp_1' })

npx startup-builder do Story.update --json '{"id":"story_1","icp":"icp_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Story.update({ id: 'story_1', icp: 'icp_1' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Story.
`icp`	ICP		The ICP it speaks to: one Story per ICP.
`hero`	`text`		Who the customer is and what they want.
`problem`	Problem		The Problem: external, internal, and the villain behind it.
`guide`	`text`		The Startup’s empathy and authority, the authority read from Metrics and Evidence.
`plan`	`text`		Three steps, each naming a declared Event.
`success`	`text`		What the customer gains.
`failure`	`text`		What the customer risks without it.
`oneLiner`	`string`		The Story in one sentence.
`direct`	Offer		The direct call to action: an Offer that makes a Customer.
`transitional`	Funnel		The transitional call to action: a Funnel opt-in that makes a Lead.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.
`stance`	`string`		The positioning the Positioning tournament chose, graded Behavior; every compiled asset recompiles when it changes.
`category`	`string`		The market category name the Story claims, as answer engines repeat it.

Outputs

Output	Type	Required	Description
`story`	Story	required	The Story.

Effects

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

Story.list

Previous Page

Survey

Next Page