---
title: "Record Step"
method: PUT
path: "/workflows/v1/upgrade-checklist/steps/{step_id}"
tags: ["Upgrade Checklist"]
---

# Record Step

`PUT /workflows/v1/upgrade-checklist/steps/{step_id}`

## Request

- Base URL: `https://api-qa.interactly.ai`
- URL: `https://api-qa.interactly.ai/workflows/v1/upgrade-checklist/steps/{step_id}`
- Auth: HTTP bearer

Record a step the checklist can't decide itself: the upgrade being done, or the health check's result.

## Path parameters

- `step_id` string, required

## Request body

- StepUpdateRequest
  - `status` 'passed' | 'needs_attention' | 'failed' | 'not_started', required
  - `detail` string, nullable
  - `checklist_id` string, nullable: The upgrade this write belongs to, as the dashboard last read it; the current one if absent

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-28** `5793b8de56f0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/interactly/apis/interactly-api-3/changes/workflows/v1/upgrade-checklist/steps/:step_id/put.md)

---

[API](https://skmtc.dev/interactly/apis/interactly-api-3.md) - [All operations](https://skmtc.dev/interactly/apis/interactly-api-3/llms.txt) - [OpenAPI document](https://skmtc.dev/interactly/apis/interactly-api-3/revisions/919b415ec222?raw)