Skip to content

by Startups.Studio

Play.update

PATCH /{namespace}/plays/{id}

Changes the given properties of a Play.

Noun: Play
Mode: do
Event: Play.updated

You, to your agent

Change the latest play.

curl -X PATCH https://api.sb/shiftnote.app/plays/play_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"family":"demand"}'

import { $ } from 'startup-builder'

const play = await $.Play.update({ id: 'play_1', family: 'demand' })

npx startup-builder do Play.update --json '{"id":"play_1","family":"demand"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Play.update({ id: 'play_1', family: 'demand' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Play.
`family`	`string`		The job it does, such as `demand`, `retention`, or `pricing`.
`cost`	`money`		What one run costs.
`cohort`	`json`		The Portfolio query a Studio rolls it out to.
`from`	`string`		Lineage: the slot it compiles from, as `Hypothesis#<slot>@v<version>`.

Outputs

Output	Type	Required	Description
`play`	Play	required	The Play.

Effects

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

Play.list

Previous Page

Play Mix

Next Page