Dashboard routes: update, delete

Reference for Dashboard, one group of Dashboard routes.

Dashboard.update

Changes the given properties of a Dashboard. Verb page.

Text

PATCH /{namespace}/dashboards/{id}

Path: id. Body, as JSON: the other inputs. Emits Dashboard.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Dashboard.
`scope`	`string`		What it views, such as a Studio, a Startup, a Team, or a Role.

Returns

Output	Type	Required	Description
`dashboard`	Dashboard	required	The Dashboard.

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/dashboards/dashboard_QL9I0ALqO4 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"Startup"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "dashboard": {
    "$id": "https://api.sb/leaseline.app/dashboards/dashboard_QL9I0ALqO4",
    "$type": "Dashboard",
    "scope": "Startup"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Dashboard.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Dashboard.delete

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