Skip to content

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.

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

Emits Keyword.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Keyword.
phrasestringThe words searched or asked.
formstringOne of search or question.

Returns

OutputTypeRequiredDescription
keywordKeywordrequiredThe Keyword.

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 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.

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

Emits Keyword.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Keyword.

Returns

OutputTypeRequiredDescription
keywordKeywordrequiredThe Keyword.

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