OverviewPlatformsAPI Reference
Segments

Delete a segment

Nobody in it is affected. Pass the `groupId` the segment was saved in.

DELETE
/v1/segments/{id}

Authorization

AuthorizationBearer <token>

API key minted via POST /v1/api-keys (format mk_live_...)

In: header

Path Parameters

idstring

Segment id (seg_...).

Length1 <= length

Query Parameters

groupId?string

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.

Length1 <= length

Response Body

application/json

application/json

curl -X DELETE "https://api.mentio.dev/v1/segments/seg_abc123"
Empty
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Create a segment POST

Save a named filter over your people. With `groupId` the segment belongs to that keyword group: it is listed, counted and changed only there, and its name only has to be unique in the group.

Get a segment GET

One segment of the scope the call names: the workspace, or the keyword group in `groupId`. A segment saved in another scope is a 404.