Skip to content

by Startups.Studio

Legal & trust Agreement

Agreement.update

PATCH /{namespace}/agreements/{id}

Changes the given properties of an Agreement.

Noun: Agreement
Mode: do
Event: Agreement.updated

You, to your agent

Change the latest agreement.

curl -X PATCH https://api.sb/ledgerlark.com/agreements/agreement_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"signedAt":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const agreement = await $.Agreement.update({ id: 'agreement_1', signedAt: '2026-10-22T12:00:00Z' })

npx startup-builder do Agreement.update --json '{"id":"agreement_1","signedAt":"2026-10-22T12:00:00Z"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agreement.update({ id: 'agreement_1', signedAt: '2026-10-22T12:00:00Z' })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Agreement.
`term`	`text`		How long it runs and how it ends.
`signedAt`	`datetime`		When the last Party signed.
`terminatedAt`	`datetime`		When it ended under its term; it stays on record.
`payoutSchedule`	`string`		For a Supplier’s Agreement: how often the released earned balance pays out.
`clearanceDays`	`integer`		For a Supplier’s Agreement: days an Order’s earnings wait after confirmation before they can pay out.

Outputs

Output	Type	Required	Description
`agreement`	Agreement	required	The Agreement.

Effects

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

Agreement.terminate

Previous Page

Attestation

Next Page