Skip to content
CLIProductSites and appsDashboard

Dashboard commands: update, delete

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

Reference for Dashboard, one group of Dashboard commands.

Dashboard.update

Changes the given properties of a Dashboard. Verb page.

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

Emits Dashboard.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Dashboard.
scopestringWhat it views, such as a Studio, a Startup, a Team, or a Role.

Returns

OutputTypeRequiredDescription
dashboardDashboardrequiredThe Dashboard.

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 Dashboard.update --json '{"id":"dashboard_QL9I0ALqO4","scope":"Startup"}'

Dashboard.delete

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

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

Emits Dashboard.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Dashboard.

Returns

OutputTypeRequiredDescription
dashboardDashboardrequiredThe Dashboard.

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