Purpose commands: update, delete
The Purpose Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Purpose, one group of Purpose commands.
Purpose.update
Changes the given properties of a Purpose. Verb page.
npx startup-builder do Purpose.update --json '<input>' [--try | --send | --do]Emits Purpose.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Purpose. |
name | string | The reason, such as marketing email or call recording. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
purpose | Purpose | required | The Purpose. |
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 Purpose.update --json '{"id":Purpose.delete
Deletes a Purpose: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Purpose.delete --json '<input>' [--try | --send | --do]Emits Purpose.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Purpose. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
purpose | Purpose | required | The Purpose. |
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 Purpose.delete --json '{"id":