Keyword commands: update, delete
The Keyword Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Keyword, one group of Keyword commands.
Keyword.update
Changes the given properties of a Keyword. Verb page.
npx startup-builder do Keyword.update --json '<input>' [--try | --send | --do]Emits Keyword.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Keyword. |
phrase | string | The words searched or asked. | |
form | string | One of search or question. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
keyword | Keyword | required | The Keyword. |
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 Keyword.update --json '{"id": "keyword_cEoeFM4Drs", "form": "search"}'Keyword.delete
Deletes a Keyword: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Keyword.delete --json '<input>' [--try | --send | --do]Emits Keyword.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Keyword. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
keyword | Keyword | required | The Keyword. |
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 Keyword.delete --json '{"id": "keyword_cEoeFM4Drs"}'