Skip to content

by Startups.Studio

Holder.update

PATCH /{namespace}/holders/{id}

Changes the given properties of a Holder.

Noun: Holder
Mode: do
Event: Holder.updated

You, to your agent

Change the latest holder.

curl -X PATCH https://api.sb/ledgerlark.com/holders/holder_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"party":"party_1"}'

import { $ } from 'startup-builder'

const holder = await $.Holder.update({ id: 'holder_1', party: 'party_1' })

npx startup-builder do Holder.update --json '{"id":"holder_1","party":"party_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Holder.update({ id: 'holder_1', party: 'party_1' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Holder.
`party`	Party		The person or entity behind the holding.

Outputs

Output	Type	Required	Description
`holder`	Holder	required	The Holder.

Effects

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

Holder.list

Previous Page

Instrument

Next Page