---
title: "PUT /api/segment/{id}"
method: PUT
path: "/api/segment/{id}"
tags: ["/api/segment"]
---

# PUT /api/segment/{id}

`PUT /api/segment/{id}`

Update a `Segment` with ID.

## Path parameters

- `id` integer, required

## Request body

- object
  - `archived` boolean, nullable
  - `caveats` string, nullable
  - `definition` object, nullable
  - `description` string, nullable
  - `name` string, nullable
  - `points_of_interest` string, nullable
  - `revision_message` string, required
  - `show_in_getting_started` boolean, nullable

## Response `2XX`

Successful response

## Other responses

- `4XX` — Client error response
- `5XX` — Server error response

---

[API](https://skmtc.net/metabase/apis/metabase-api.md) · [All operations](https://skmtc.net/metabase/apis/metabase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/metabase/metabase-api/versions/08b5a2bafb4f/schema)