Skip to content

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.

Text
npx startup-builder do Play.update --json '<input>' [--try | --send | --do]

Emits Play.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Play.
familystringThe job it does, such as demand, retention, or pricing.
costmoneyWhat one run costs.
cohortjsonThe Portfolio query a Studio rolls it out to.
fromstringLineage: the slot it compiles from, as Hypothesis#<slot>@v<version>.

Returns

OutputTypeRequiredDescription
playPlayrequiredThe Play.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
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.

Text
npx startup-builder do Play.delete --json '<input>' [--try | --send | --do]

Emits Play.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Play.

Returns

OutputTypeRequiredDescription
playPlayrequiredThe Play.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Play.delete --json '{"id":"play_hr4WTcrAyZ"}'