Play routes: update, delete

Reference for Play, one group of Play routes.

Play.update

Changes the given properties of a Play. Verb page.

Text

PATCH /{namespace}/plays/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

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

JSON

{
  "api": "https://api.sb/leaseline.app",
  "play": {
    "$id": "https://api.sb/leaseline.app/plays/play_hr4WTcrAyZ",
    "$type": "Play",
    "family": "demand"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Play.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Play.delete

Deletes a Play: a soft delete that keeps its history, undone by Thing.restore. Verb page.