OverviewPlatformsAPI Reference
People

Update your annotations on a person

Tags, notes, mute, and the outreach owner (a workspace member; null clears) and stage, for your workspace only. Mute hides their posts from your feed and every channel; ingest and billing never change. With `groupId` the annotations are that keyword group's own: `muted` hides the person, and the accounts that group merged into them, from the mentions of that group's keywords only (feed, alerts and digests), and the group's tags show on those mentions next to the workspace's. A mute set without `groupId` hides them everywhere.

PATCH
/v1/people/{id}

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

idstring

Person id (aut_...).

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

Request Body

tags?array<string>

Replaces the whole list.

Itemsitems <= 20
notes?string
Lengthlength <= 2000
muted?boolean

true hides their posts from the feed, the alerts and the digests; false shows them again. Without groupId, for every keyword of the workspace; with groupId, for the mentions of that group's keywords only, leaving the workspace's mute as it is.

ownerId?string|null

The member who owns the contact (user id); null clears.

Length1 <= length
stage?string

Where your workspace stands with the person: not_contacted, contacted, replied, in_talks, customer or not_a_fit.

Value in"not_contacted" | "contacted" | "replied" | "in_talks" | "customer" | "not_a_fit"

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.mentio.dev/v1/people/aut_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "platform": "bluesky",
  "name": "string",
  "handle": "string",
  "url": "string",
  "avatarUrl": "string",
  "accounts": [
    {
      "id": "string",
      "platform": "bluesky",
      "name": "string",
      "handle": "string",
      "url": "string"
    }
  ],
  "reach": {
    "followers": 0,
    "following": 0,
    "posts": 0
  },
  "profile": {
    "bio": "string",
    "company": "string",
    "location": "string",
    "website": "string",
    "email": "string",
    "links": [
      {
        "provider": "string",
        "url": "http://example.com"
      }
    ],
    "fetchedAt": "string"
  },
  "stats": {
    "mentions": 0,
    "relevant": 0,
    "sentiment": {
      "positive": 0,
      "neutral": 0,
      "negative": 0
    },
    "firstSeenAt": "string",
    "lastSeenAt": "string"
  },
  "annotations": {
    "tags": [
      "string"
    ],
    "notes": "string",
    "muted": true
  },
  "outreach": {
    "owner": {
      "id": "string",
      "name": "string",
      "email": "string"
    },
    "stage": "not_contacted",
    "lastContactedAt": "string"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Undo a merge POST

The account becomes its own person again. With `groupId`, the call works inside that keyword group: its people, and its own tags, notes, mute, merges and activities, apart from the workspace's and from every other group's.

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.