Play commands: update, delete
The Play Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Play, one group of Play commands.
Play.update
Changes the given properties of a Play. Verb page.
npx startup-builder do Play.update --json '<input>' [--try | --send | --do]Emits Play.updated.
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>. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
play | Play | required | The Play. |
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. | None. |
Example
npx startup-builder do Play.update --json '{"id": "play_hr4WTcrAyZ", "family": "demand"}'Play.delete
Deletes a Play: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Play.delete --json '<input>' [--try | --send | --do]Emits Play.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Play. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
play | Play | required | The Play. |
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. | None. |
Example
npx startup-builder do Play.delete --json '{"id": "play_hr4WTcrAyZ"}'