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.
npx startup-builder do Party.update --json '<input>' [--try | --send | --do]Emits Party.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Party. |
name | string | The legal or personal name. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
party | Party | required | The Party. |
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. | None. |
Example
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.
npx startup-builder do Party.delete --json '<input>' [--try | --send | --do]Emits Party.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Party. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
party | Party | required | The Party. |
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. | None. |
Example
npx startup-builder do Party.delete --json '{"id": "party_hmQWaPrAyZ"}'