Skip to content

by Startups.Studio

Core grammar Action Task Approval

Approval.update

PATCH /{namespace}/approvals/{id}

Changes the given properties of an Approval.

Noun: Approval
Mode: do
Event: Approval.updated

You, to your agent

Change the latest approval.

curl -X PATCH https://api.sb/kilnbakery.com/approvals/approval_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verdict":"allowed"}'

import { $ } from 'startup-builder'

const approval = await $.Approval.update({ id: 'approval_1', verdict: 'allowed' })

npx startup-builder do Approval.update --json '{"id":"approval_1","verdict":"allowed"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Approval.update({ id: 'approval_1', verdict: 'allowed' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Approval.
`by`	Worker		The Worker that performed it.
`for`	Party		The Party it was done on behalf of.
`via`	`string`		The Interface or request it arrived through.
`on`	`string`		The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`		The record, at the Version the Action was decided against.
`input`	`json`		The input it was called with.
`createdAt`	`datetime`		When it was called.
`reserved`	`money`		The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`		When the Task is due.
`priority`	`integer`		Its rank in the inbox, highest first.
`recurrence`	`string`		The schedule a recurring duty repeats on.
`verdict`	`string`		One of `allowed` or `refused`.
`deadline`	`datetime`		When an unanswered Approval cancels the Action.

Outputs

Output	Type	Required	Description
`approval`	Approval	required	The Approval.

Effects

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

Approval.refuse

Previous Page

Capability

Next Page