Workflow routes: update, delete

Reference for Workflow, one group of Workflow routes.

Workflow.update

Changes the given properties of a Workflow. Verb page.

Text

PATCH /{namespace}/workflows/{id}

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "workflow": {
    "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
    "$type": "Workflow",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Workflow.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Workflow.delete

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