# Dashboard routes: update, delete

URL: /code/api/dashboard/records-update · Id: `page:code/api/dashboard/records-update`

> The Dashboard Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for [Dashboard](/business/nouns/dashboard), one group of [Dashboard routes](/code/api/dashboard).

### Dashboard.update
Changes the given properties of a Dashboard. [Verb page](/business/nouns/dashboard/update?interface=api).

```text
PATCH /{namespace}/dashboards/{id}
```

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

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `dashboard` | [Dashboard](/business/nouns/dashboard) | Yes | The Dashboard. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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](/business/nouns/dashboard/delete?interface=api).

```text
DELETE /{namespace}/dashboards/{id}
```

Path: `id`. Emits `Dashboard.deleted`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Dashboard. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `dashboard` | [Dashboard](/business/nouns/dashboard) | Yes | The Dashboard. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X DELETE https://api.sb/leaseline.app/dashboards/dashboard_QL9I0ALqO4 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```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.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```