# recordLessonRead

mutation · in the family [Your own session](/reference/your-own-session/)

## What it does

Note that you read one step of a play — your own progress record; reading it again changes nothing.

Note that YOU read ONE step of ONE play: your own progress record's step ledger — sorted, unique, IDEMPOTENT (a step already read is a no-op success, nothing written). playKey must be a live play key and stepN one of its steps (VALIDATION otherwise). Requires the unrestricted capability on a USER session.

## What happens

Writes only your own progress.

## Who may call it

Capability area: **Your own session** — What every signed-in person may do for themselves — their session, their profile and their own work.

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

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `playKey` | [String](/types/#scalars) `String!` | yes | No further notes. |
| `stepN` | [Int](/types/#scalars) `Int!` | yes | No further notes. |

## Returns

[MyTrainingPlayProgress](/types/MyTrainingPlayProgress/) `MyTrainingPlayProgress!` — One play's reading — the steps you have read (1-based, sorted, unique) and the last read instant.

## Example request

```graphql
mutation ExampleRecordLessonRead($playKey: String!, $stepN: Int!) {
  recordLessonRead(playKey: $playKey, stepN: $stepN) {
    playKey
    stepsRead
    lastReadAt
  }
}
```

Variables:

```json
{
  "playKey": "<play key>",
  "stepN": 1
}
```

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

## Example response

```json
{
  "data": {
    "recordLessonRead": {
      "playKey": "<play key>",
      "stepsRead": [
        1
      ],
      "lastReadAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "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/))
- `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/))