# setDashboardLanding

mutation · in the family [Work and notes](/reference/work-and-notes/)

## What it does

Make one dashboard the landing the office opens on — the previous landing steps down in the same move — or clear it.

Make a Dashboard the org group's LANDING, or clear it: on = true swaps ATOMICALLY in ONE transaction — the previous landing row flips off and the target flips on, each conditioned on the revision this call read (a lost race refuses CONFLICT/REVISION_STALE naming the row; re-read and retry); on = false clears the flag; already so is a no-op. Only an ACTIVE dashboard can land (an inactive or doomed target refuses CONFLICT/REF_STATE — reactivate it first); deactivating or dooming the landing clears the flag in the same write. The ONE door: createDashboard / updateDashboard refuse the field. Requires the unrestricted capability.

## What happens

Changes which saved layout greets everyone who lands on the dashboard; the layouts themselves are untouched. Only an active dashboard can be the landing; deactivating or retiring the landing clears it.

## Who may call it

Capability area: **Work and notes** — Tasks, notes, messages, dashboards and the everyday tools every staff member keeps.

- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows `api:setDashboardLanding`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | yes | The id of the record. |
| `on` | [Boolean](/types/#scalars) `Boolean!` | yes | No further notes. |

## Returns

[Dashboard](/types/Dashboard/) `Dashboard!` — A Dashboard: a merchant-authored CANNED-METRIC widget layout (no ad-hoc OLAP: the construct stores the LAYOUT only; every output derives downstream of the event lake; the office renderer realizes the tokens when the face lands). widgets = 1..16 ordered rows, each naming ONE canned metric (the v1 roster: sales_today · sales_week · orders_open · sell_through_30d · inventory_value · low_stock_count · cs_open_cases · review_average · loyalty_signups_30d · fraud_alerts_open · units_by_day_30d); ordinals unique; wholesale-replace on edit. NOT searchable.

## Example request

```graphql
mutation ExampleSetDashboardLanding($id: ID!, $on: Boolean!) {
  setDashboardLanding(id: $id, on: $on) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    landing
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "on": true
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "setDashboardLanding": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "DA-EXMP-0000-000F",
      "type": "Dashboard",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "landing": true
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))