Skip to content

by Startups.Studio

Product Sites and apps Flow

Flow.update

PATCH /{namespace}/flows/{id}

Changes the given properties of a Flow.

Noun: Flow
Mode: do
Event: Flow.updated

You, to your agent

Change the latest flow.

curl -X PATCH https://api.sb/patentpad.com/flows/flow_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"persona":"persona_1"}'

import { $ } from 'startup-builder'

const flow = await $.Flow.update({ id: 'flow_1', persona: 'persona_1' })

npx startup-builder do Flow.update --json '{"id":"flow_1","persona":"persona_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Flow.update({ id: 'flow_1', persona: 'persona_1' })"
  }
}

Update changes the given properties of a Flow. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Flow.
`persona`	Persona		The Persona it guides; its Role decides which Verbs each step offers.
`offer`	Offer		The Offer whose activation Event ends the Flow; time to value reads from first step to that Event.
`steps`	list of Dashboard		The Dashboards in order, first run first, each ending in the Verb that opens the next.

Outputs

Output	Type	Required	Description
`flow`	Flow	required	The Flow.

Effects

Emits Flow.updated.
Two-way: try, send, do.

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.	Flow.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Flow.list

Previous Page

Form

Next Page