Skip to content

by Startups.Studio

Party.update

PATCH /{namespace}/parties/{id}

Changes the given properties of a Party.

Noun: Party
Mode: do
Event: Party.updated

You, to your agent

Change the party “LedgerLark”.

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

import { $ } from 'startup-builder'

const party = await $.Party.update({ id: 'party_1', name: 'LedgerLark' })

npx startup-builder do Party.update --json '{"id":"party_1","name":"LedgerLark"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Party.update({ id: 'party_1', name: 'LedgerLark' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Party.
`name`	`string`		The legal or personal name.

Outputs

Output	Type	Required	Description
`party`	Party	required	The Party.

Effects

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