Skip to content

by Startups.Studio

Core grammar Process

Process.update

PATCH /{namespace}/processes/{id}

Changes the given properties of a Process.

Noun: Process
Mode: do
Event: Process.updated

You, to your agent

Change the latest process.

curl -X PATCH https://api.sb/petpantry.shop/processes/process_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"PetPantry"}'

import { $ } from 'startup-builder'

const process = await $.Process.update({ id: 'process_1', name: 'PetPantry' })

npx startup-builder do Process.update --json '{"id":"process_1","name":"PetPantry"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Process.update({ id: 'process_1', name: 'PetPantry' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Process.
`name`	`string`		The name in sentence case, such as `Month-end close`.
`says`	`text[]`		What a founder says to run, turn on, or ask about it.
`settings`	`json`		The Settings it reads: key, type, default, the founder’s sentence and the Verb that sets each.
`defaultOn`	`string[]`		The Product Templates it is on in by default.
`wakes`	`json`		The Events that wake it in the Startup’s own records.
`inputs`	`string[]`		The Nouns an Action reads at its start.
`outputs`	`string[]`		The Nouns a finished Action leaves behind, rolled up from its Workflows.
`outcome`	`text`		What a finished Action leaves true, in one sentence.
`serviceLevel`	`json`		Its target duration, clock, escalation Role, and the waits that stop the clock.
`scope`	`string`		Where it runs: `startup`, `studio`, or `any`.

Outputs

Output	Type	Required	Description
`process`	Process	required	The Process.

Effects

Emits Process.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.	Process.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`.

Process.pause

Previous Page

Question

Next Page