Skip to content

Approval commands: update, delete

The Approval Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Approval, one group of Approval commands.

Approval.update

Changes the given properties of an Approval. Verb page.

Text
npx startup-builder do Approval.update --json '<input>' [--try | --send | --do]

Emits Approval.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Approval.
byWorkerThe Worker that performed it.
forPartyThe Party it was done on behalf of.
viastringThe Interface or request it arrived through.
onstringThe Action or Event that caused it, such as the failed attempt a retry follows.
thingstringThe record, at the Version the Action was decided against.
inputjsonThe input it was called with.
createdAtdatetimeWhen it was called.
reservedmoneyThe most this Action may cost, held against its Limits from the check until it settles, billed misses included.
duedatetimeWhen the Task is due.
priorityintegerIts rank in the inbox, highest first.
recurrencestringThe schedule a recurring duty repeats on.
verdictstringOne of allowed or refused.
deadlinedatetimeWhen an unanswered Approval cancels the Action.

Returns

OutputTypeRequiredDescription
approvalApprovalrequiredThe Approval.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

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

Approval.delete

Deletes an Approval: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
npx startup-builder do Approval.delete --json '<input>' [--try | --send | --do]

Emits Approval.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Approval.

Returns

OutputTypeRequiredDescription
approvalApprovalrequiredThe Approval.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Approval.delete --json '{"id":"approval_TlxQeWh9uX"}'