Skip to content
CLIProductSites and appsFlow

Flow commands: update, delete

The Flow Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Flow, one group of Flow commands.

Flow.update

Changes the given properties of a Flow. Verb page.

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

Emits Flow.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Flow.
personaPersonaThe Persona it guides; its Role decides which Verbs each step offers.
offerOfferThe Offer whose activation Event ends the Flow; time to value reads from first step to that Event.
stepslist of DashboardThe Dashboards in order, first run first, each ending in the Verb that opens the next.

Returns

OutputTypeRequiredDescription
flowFlowrequiredThe Flow.

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 Flow.update --json '{"id":"flow_uuJzIzjvrp","persona":"persona_YdpO6wSexq"}'

Flow.delete

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

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

Emits Flow.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Flow.

Returns

OutputTypeRequiredDescription
flowFlowrequiredThe Flow.

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 Flow.delete --json '{"id":"flow_uuJzIzjvrp"}'