Skip to content
CLISpec and limitsCLI reference

Portfolio commands: update, delete

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

Reference for Portfolio, one group of Portfolio commands.

Portfolio.update

Changes the given properties of a Portfolio. Verb page.

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

Emits Portfolio.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Portfolio.
typelist of NounThe Nouns this Thing is an instance of.
outsidejsonThe ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
queryjsonThe saved query that defines a dynamic Collection.
membershipstringHow each member belongs: held, owned, contracted, or made.

Returns

OutputTypeRequiredDescription
portfolioPortfoliorequiredThe Portfolio.

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 Portfolio.update --json '{"id":"portfolio_zkvUnP8LwY","membership":"held"}'

Portfolio.delete

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

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

Emits Portfolio.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Portfolio.

Returns

OutputTypeRequiredDescription
portfolioPortfoliorequiredThe Portfolio.

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