Skip to content

Party commands: update, delete

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

Reference for Party, one group of Party commands.

Party.update

Changes the given properties of a Party. Verb page.

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

Emits Party.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Party.
namestringThe legal or personal name.

Returns

OutputTypeRequiredDescription
partyPartyrequiredThe Party.

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 Party.update --json '{"id":"party_hmQWaPrAyZ","name":"Leaseline"}'

Party.delete

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

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

Emits Party.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Party.

Returns

OutputTypeRequiredDescription
partyPartyrequiredThe Party.

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 Party.delete --json '{"id":"party_hmQWaPrAyZ"}'