Segments

Update a segment

Only the fields sent change. Pass the groupId the segment was saved in; a segment cannot move between scopes.

patch/v1/segments/{id}

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/segments/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Segment id (seg_...).

Example:seg_abc123

Query parameters

groupIdstring

Scope to one keyword group (grp_...): only people who mentioned that group's keywords, with that group's own tags, notes, mute, merges, activities and segments. Omit for the whole workspace.

Request body

namestring
descriptionstring

Response

The updated segment

idstring required

Segment id (seg_...).

namestring required
descriptionstring required
groupIdstring nullable required

The group this segment belongs to, or null for a workspace segment.

countinteger required

People in the segment right now; it is evaluated on every read.

createdAtstring required

ISO 8601 timestamp, UTC.

updatedAtstring required

ISO 8601 timestamp, UTC.

Changes

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