Workflow programs: update, delete

Reference for Workflow, one group of Workflow programs.

Workflow.update

Changes the given properties of a Workflow. Verb page.

Text

do: return await $.Workflow.update(input)

Emits Workflow.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Workflow.
`steps`	`json`		The ordered steps, each run by a Function.
`retries`	`integer`		How many times a failed step retries.
`body`	`string`		The Verb whose Action it is the durable body of, such as `Order.refund`; a Workflow with a body has no Trigger.

Returns

Output	Type	Required	Description
`workflow`	Workflow	required	The Workflow.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Workflow.update({ id: 'workflow_2dhYBlEno0', steps: {} })"
  }
}

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