---
title: "Update Spotlight"
method: PATCH
path: "/v1/spotlights/{spotlight_id}"
tags: ["spotlights"]
---

# Update Spotlight

`PATCH /v1/spotlights/{spotlight_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/spotlights/{spotlight_id}`
- Auth: HTTP bearer

## Path parameters

- `spotlight_id` string, required

## Headers

- `x-api-key` string, nullable

## Request body

- SpotlightUpdate
  - `title` string, nullable
  - `description` string, nullable
  - `character_name` string, nullable
  - `player_name` string, nullable
  - `style` string, nullable
  - `custom_theme` object, nullable
  - `order_index` integer, nullable
  - `source_moment_id` string, nullable

## Response `200`

Successful Response

- SpotlightRead
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, nullable
  - `id` string, required
  - `title` string, required
  - `description` string
  - `character_name` string
  - `player_name` string
  - `style` string
  - `custom_theme` object, nullable
  - `order_index` integer
  - `entry_type` string
  - `source_moment_id` string, nullable
  - `pipeline_id` string, nullable
  - `recap_set_id` string, nullable
  - `session_id` string, required
  - `campaign_id` string, required

## 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)