---
title: "Record how far the caller went through a first-mission guide"
method: PUT
path: "/me/guides/{guideId}"
tags: ["identity"]
---

# Record how far the caller went through a first-mission guide

`PUT /me/guides/{guideId}`

## Request

- Base URL: `https://api.letsship.ai/v1`
- URL: `https://api.letsship.ai/v1/me/guides/{guideId}`
- Auth: none declared

## Path parameters

- `guideId` 'mission-control' | 'mission-detail' | 'mission-results', required

## Query parameters

- `orgId` string

## Request body

- UpdateSetupGuideRequest
  - `step` integer, required
  - `completed` boolean

## Response `200`

Saved; a finished guide stays finished

- SetupGuide
  - `id` 'mission-control' | 'mission-detail' | 'mission-results', required
  - `step` integer, required
  - `completedAt` integer, nullable, required

## Other responses

- `401`: Unauthenticated
- `403`: The token acts for no person, so there is nobody to save it for (code person_required)
- `404`: Not one of the caller's orgs

---

[API](https://skmtc.dev/letsship/apis/ship-api.md) · [All operations](https://skmtc.dev/letsship/apis/ship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/letsship/apis/ship-api/revisions/e6eac1bcadd4?raw)