---
title: "Patch Beat"
method: PATCH
path: "/v1/beats/{beat_id}"
tags: ["beats"]
---

# Patch Beat

`PATCH /v1/beats/{beat_id}`

## Request

- Base URL: `https://api.myarchivist.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.myarchivist.ai/v1/beats/{beat_id}`
- Auth: HTTP bearer

## Path parameters

- `beat_id` string, required

## Headers

- `x-api-key` string, nullable

## Request body

- BeatUpdate
  - `label` string, nullable
  - `description` string, nullable
  - `type` 'major' | 'minor' | 'step'
  - `index` integer, nullable
  - `metadata` object, nullable
  - `parent_id` string, nullable
  - `game_session_id` string, nullable
  - `game_session_ids` string[], nullable

## Response `200`

Successful Response

- BeatRead
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable
  - `id` string, required
  - `label` string, required
  - `description` string, nullable
  - `type` 'major' | 'minor' | 'step'
  - `index` integer
  - `metadata` object, nullable
  - `parent_id` string, nullable
  - `campaign_id` string, required
  - `game_session_ids` string[]
  - `game_session_id` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/myarchivist/apis/archivist-public-api.md) · [All operations](https://skmtc.dev/myarchivist/apis/archivist-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/myarchivist/apis/archivist-public-api/revisions/3ea6ca7efc56?raw)