v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/segment

PUT /api/segment/{id}

Update a Segment with ID.

put/api/segment/{id}

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

archivedboolean nullable
caveatsstring nullable
definitionobject nullable
descriptionstring nullable
namestring nullable
points_of_intereststring nullable
revision_messagestring required
show_in_getting_startedboolean nullable

Response

Successful response