Segments

Rename a segment

Update the name of an existing segment without changing its ID, entity type, or memberships.

patch/segments/{id}

Request

Base URL
https://api.commonroom.io/api/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/segments/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The prefixed segment ID (format s_<number>)

Request body

namestring required

Response

Segment renamed

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.